Magnum One

home *** CD-ROM | disk | FTP | other *** search

/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d3 / ued.arc / UED.DOC < prev next >

Wrap

Text File | 1989-02-01 | 25.1 KB | 638 lines

Useful Editor Documentation =========================== Features ~~~~~~~~ Useful Editor (Ued) is a small (about 32K), fast, ASCII editor that is suitable for a wide variety of text manipulation tasks. Some of Ued's features include: - ability to edit up to 9 files in memory at once - files as large as 1000 characters wide and 10,000 lines long - file size is only limited by available memory - split screen editing - typeover and insert mode editing - search and replace (both case sensitive and insensitive) - cut and paste (three modes: line, range, and block) - escape to DOS - word wrap and paragraph reformat - smart indentation - easy to use consistent interface - user configurable preferences System Requirements ~~~~~~~~~~~~~~~~~~~ Ued runs on any IBM PC or compatible. Ued automatically determines the type of video card installed and switches the card into 80 X 25 text mode when it starts up. The following video cards (or ones that are compatible) are supported: - Color Graphics Adapter (CGA) - Monochrome Graphics Adapter (MGA) - Hercules Graphics Adapter (HGA) Any monitor that can display 80 X 25 text works with Ued. If you have a color monitor and card, you can change the default colors (of black and white) by running uedcfg.exe (see Configuring Ued). Ued is very small and runs on systems with as little as 128K of memory. Of course the more memory that you have, the larger the files that you are able to edit. Starting Up Ued ~~~~~~~~~~~~~~~ From the DOS prompt, type: Ued <filename1> <filename2> ... <filename9> then press the Enter key. Each "filename" is either an ASCII text file that you want to edit or the name of a file that you want to create. Up to 9 file names can be specified on the command line when starting up Ued. Each file is assigned to its own workspace. You can also start up Ued with no files specified. In this case the editor starts within an empty unnamed workspace. Workspaces ~~~~~~~~~~ Files are loaded into Ued "workspaces". A workspace can be as much as 1,000 characters wide, and 10,000 lines deep. You can move the cursor anywhere in the workspace to edit text. The "text window" follows the cursor as you move about the workspace. There are 9 workspaces (numbered 1-9) in Ued, each of which can hold a single file. The F2 Workspace command is used to switch between work- spaces. Ued maintains one other workspace (workspace 0) which is used as a "clipboard" when you Cut and Paste text. Screen Layout ~~~~~~~~~~~~~ Ued uses the top 23 lines of the screen to display the text being edited. Consider this to be a "window" (that is 80 columns wide and 23 lines deep) into the "text workspace". This window is bordered on the top and sides by the edge of the screen, and bounded on the bottom by an inverse line. That inverse line is called the "status line". On the left edge of the status line is a number (0-9) which indicates what workspace that you are in. Beside it appears the name of the file that you are edit- ing in that workspace. To the right side of the status line, the line and column position of the cursor is displayed. Below the status line are the command lines. All of the commands that are currently available to you are displayed on these two lines. The Cursor(s) ~~~~~~~~~~~~~ The "cursor" is a pointer within a workspace. Text can be added or deleted here. In Ued the cursor appears as a solid inverted block when you are in "insert mode", and a flashing underscore when you are in "typeover mode". When you start up Ued a cursor appears in the upper left hand corner of the text window. This is your "active" cursor. In actual fact there are two cursors in Ued. An "inactive" cursor is initially pos- itioned there as well but not displayed. When you move the active cursor, the inactive cursor remains where it is. You can move the active cursor to the inactive cursor position by using the "Flip" command (Ctrl-F). The position that you moved from becomes the inactive cursor position. The inactive cursor can be used as a "bookmark" in your text (a place that you want to get to quickly) and also plays an important role in the F8 Split command. Moving the Cursor ~~~~~~~~~~~~~~~~~ Moving the cursor around can be accomplished with the following keys. In all cases, the text window is adjusted when necessary in order to keep the cursor on the screen. Up Arrow Moves the cursor up one line of text. Down Arrow Moves the cursor down one line of text. -> Moves the cursor right one character. <- Moves the cursor left one character. Home Moves the cursor to the first character on the current line. If you are already on the first character, moves the cursor to column 1. End Moves the cursor one position past the last character on the current line. PgUp Moves the cursor up one screen of text. PgDn Moves the cursor down one screen of text. Additional cursor movement commands can be accessed by holding down the "Ctrl" key (you will see the menu change when you do this) and pressing one of these keys: Ctrl -> Moves the cursor to the beginning of the next word. (A word is considered to be a series of characters preceded and followed by at least one space.) Ctrl <- Moves the cursor to the beginning of the previous word. Flip Moves the active cursor to the inactive cursor position. The current cursor position becomes the inactive cursor. Goto Line Prompts for a line number, then moves the cursor to the line number entered. Adjusts the text window so that the cursor is centered vertically in the window.. Outdent Moves the cursor left to the previous level of indentation. Ctrl Home Moves the cursor to the first line of the current file. Ctrl End Moves the cursor one line past the end of the current file. Ctrl PgDn When a search Pattern has been defined, moves the cursor to the next occurrence of Pattern in the text. Ctrl PgUp When a search Pattern has been defined, moves the cursor to the previous occurrence of Pattern in the text. Entering Text ~~~~~~~~~~~~~ To enter text into Ued, position the cursor where you want the text to be added and then type. If you make a mistake use the Backspace or Del key to erase the error. In insert mode, characters to the right of the solid block cursor (including the current character) shift right to make room for new text being entered. You can do "power" data entry using Ued by turning on the "word wrap" feature found under the Text command. When you turn word wrap on you will notice an inverse line appear down the right side of the screen. This line marks the right margin. With word wrap on, any word that is incomplete when it "hits" the right margin is moved down to the next line. With this feature you can enter long passages of text without having to worry about the ends of lines. You can alter the position of the right margin with the Set and Enter options of the Text command. Ued considers a block of text separated by at least one blank line above and below to be a paragraph. Editing text within a paragraph when word wrap is on might be a little disconcerting at first, especially when in insert mode. Ued makes no attempt to reformat paragraph text "on-the-fly" as you are editing it. When in insert mode Ued moves any text to the right of the cursor down to the next line (if necessary) to make room for new text. The Paragraph Reformat option under the Text command can be used to fix things up after you have made all your changes. Smart Indentation ~~~~~~~~~~~~~~~~~ When you press the Enter key, the cursor moves down one line and Ued positions the cursor under the first character of the current line. This makes it easy to enter blocks of indented text. Similarly the Paragraph Reformat looks at the leading spaces on the second line of a paragraph to determine where to place the left margin (the right margin is "set" explicitly). Any positive or negative indentation on the first line will be preserved. The Outdent option under the Ctrl key moves the cursor to the previous level of indentation (which it determines by looking "up" in the text of the workspace). Deleting Things ~~~~~~~~~~~~~~~ Characters are deleted with the following keys: Del Deletes the character under the cursor. Any text to the right of that character shifts left to "fill the gap". If the cursor is past the end of the line and you are in insert mode, Ued brings up the next line of text and joins it with the current line. Backspace Moves the cursor left one character. If you are in insert mode, Ued deletes the character to the left of the cursor and all text to the right of and including the cursor shifts left. Also in insert mode, if the cursor is in column 1, Ued moves the current line up and joins it with the previous line. Backtab Moves the cursor to the previous tab stop. If you are in insert mode, all characters to the left of the cursor up to and including the previous tab stop are deleted. By pressing and holding down the Alt key, a sub-menu with the follow- ing additional delete options appears: Word Deletes the word under the cursor. If the cursor is not on a word, the first word to the left of the cursor (if there is one) is deleted. Beginning of Line Deletes all of the text to the left of the cursor. The remaining text and the cursor shift left to the current level of indentation. End of Line Deletes all of the text to the right of and including the character under the cursor. Line Deletes the line that the cursor is on. Other Keys You Should Know About ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The following keys are important to the operation of Ued: Esc Returns to the previous level of menus. If you are at the main command menu nothing happens. Ins Switches between "typeover" and "insert" modes. Enter Moves the cursor down one line and positions it at the cur- rent level of indentation. If you are in insert mode, a new line is created immediately after the current line, and any text to the right of and including the cursor character is moved down with the cursor. Tab Moves the cursor to the next tab stop. If you are in insert mode, characters to the right of and including the cursor character shift right with the cursor. Main Menu Commands ~~~~~~~~~~~~~~~~~~ The function keys F1 - F10 are used to access the main Ued command set. These commands are invoked by pressing the appropriate function key. In addition, pressing and holding down the Ctrl key reveals additional cursor movement keys. Pressing and holding down the Alt key is used for Delete functions. Many of the main menu commands have sub-options. Sub-option menus replace the main command menu when invoked. They show the main com- mand selected in inverse text (just below the file name on the status line) and the option choices on the bottom line of the screen. You select an option by pressing the first (highlighted) letter or char- acter of the appropriate choice. You can always get out of sub-option menu(s) by pressing the Esc key, or by selecting another main menu command. The sections that follow describe the main menu commands and sub- options in more detail. F1 File ~~~~~~~ File commands are used to copy Ued workspaces to and from disk files. In addition the current workspace can be erased or renamed. Load Prompts for the name of a file to load. If the entered file name is found on the disk in the current directory, Ued copies it into the workspace at the current cursor position. Existing text is moved to make room for the text being loaded. An empty workspace is given the name of the first file loaded into it. Save The workspace text is copied to a disk file in the current directory and given the current workspace name. Ued prompts for a file name if the workspace is unnamed. Name Prompts for a name for the current workspace. The name entered must be a valid DOS file name. If the name is the same as one on your disk in the current directory, Ued prompts you to verify that you really want to use that name. Clear Erases the contents of the current workspace. If the work- space has been changed since that last time it was saved, Ued prompts you to verify that you really want to clear the workspace. F2 Workspace ~~~~~~~~~~~~ The Workspace command allows you to switch between the files that you have loaded. In addition some status information about workspaces is displayed as follows: > This symbol appears to the left of a workspace number if that workspace has been used at any time during the current edit session. * When this symbol appears immediately after a workspace number it means that the workspace has been changed in some way since it was last saved. <- This arrow points to the number of the workspace that is currently being displayed in the active window. To move between workspaces use the following keys: <- Displays the previous (lower numbered) workspace. -> Displays the next workspace. Enter Moves you into the workspace pointed to by <-. 0 - 9 Moves directly to the workspace who's number is pressed. Esc Moves you to the workspace that was active when the F2 Workspace command was invoked. F3 Search ~~~~~~~~~ Search allows you to find strings or "Patterns" within the text of the current workspace and optionally substitute a "Replacement" string of your choosing. Count Displays the total number of times that the Search Pattern appears in the text of the current workspace. Fix Substitutes the Replacement string for a Pattern string provided that the cursor is on a piece of text matching Pattern (the text will be highlighted). Global All instances of text in the current workspace matching the Pattern string are changed to the Replacement string. Pattern Prompts for a search Pattern. If the Pattern entered is in all lower case, searches will be case insensitive. If any of the letters in the Pattern are in upper case, the work- space text and Pattern must be exactly the same for a match to occur. Replace- ment Prompts for a Replacement string. The Replacement string can be empty, which has the effect of deleting the Pattern when a Fix or Global substitution is applied. Changing the Pattern automatically clears the Replacement string. PgUp Moves the cursor to the previous occurrence of Pattern in the current workspace. If there are no more matches, moves the cursor to the beginning of the workspace. PgDn Moves the cursor to the next occurrence of Pattern in the current workspace. If there are no more matches, moves the cursor to the end of the workspace. F4 Print ~~~~~~~~ The contents of the current workspace are sent to the printer attached to LPT1. No formatting is performed on the text. F5 Cut ~~~~~~ Cut allows you to select a block of text which can subsequently be deleted, copied, moved, or shifted. Text selection begins at the current cursor position. As you move the cursor around (using the standard cursor movement keys) selected text is highlighted. Selection ends when you press the Copy, Delete, or Move command keys. How the text gets marked out depends on the Cut mode that you are in. The three Cut styles are: Block A rectangular block of text. Line Whole lines of text only. Range All the text from one selected position in the text to another. Any time that you select a block of text and copy, move, or delete it, the selected text is copied to workspace 0. Workspace 0 thus acts as the "clipboard" or "cut buffer" for Ued. The former contents of work- space 0 are lost when newly selected text is copied to it. You can edit in workspace 0 as you would any other workspace, but you have to be careful because of the transient nature of the text placed here (ie. its NOT a good idea to load files into workspace 0). Once marked, there are four operations that can be performed on the highlighted text. Copy Copies the selected text to workspace 0. Delete Copies the selected text to workspace 0 then removes it from the current workspace. Move Copies the selected text to workspace 0, removes it from the workspace, then prompts you to position the cursor where you want the text moved. When you press Enter to complete the operation, the selected text is copied to the new location. +/- Shifts the selected text right (+) or left (-). Text cannot be shifted over text that is not highlighted. You will notice that the highlighting does not go away. After shifting you can perform one of the other Cut operations, or press Esc to quit the Cut command. F6 Paste ~~~~~~~~ This command copies the text from workspace 0 into the current work- space at the current cursor position. If you are in insert mode, the workspace text is moved to make room for the workspace 0 text being added. Care should be exercised when you are in typeover mode as the workspace 0 text is copied on top of the text in the current work- space. If there are more than 2 lines of text being Pasted and you are in typeover mode, you are asked to verify that you really want to Paste. F7 DOS ~~~~~~ When you press F7, Ued starts up another DOS session by executing the secondary command processor. Ued looks at the environment variable COMSPEC= for the name of the secondary command processor. This is usually COMMAND.COM. The F7 Dos command fails if: - COMSPEC= is not set in the environment - the command processor indicated by COMSPEC could not be found - there is not enough memory to run the command processor To return to Ued, from the DOS prompt type: exit then press the Enter key. F8 Split/Zoom ~~~~~~~~~~~~~ Pressing F8 splits the text window horizontally at the current cursor position. A second status line appears separating the two windows. The upper window shows the text at the active cursor, while the lower window shows the text at the inactive cursor position. You can flip between the windows using the Ctrl-F command. Both windows can "view" the same workspace, or each can be positioned on a different workspace. If they are both positioned over the same piece of text, changes made in one will be echoed to the other. Pressing F8 again expands (zooms) the window containing the active cursor to be the size of a full screen. The window containing the text pointed to by the inactive cursor is no longer displayed. F9 Text ~~~~~~~ The Text command offers some simple word processing options. Enter Right Margin Prompts for the column that you want words to wrap at. The column must be in the range 20 to 250. Set Right Margin The right margin is placed one character position past the longest line in the current paragraph (ie. the one that the cursor is on). Reformat Paragraph Adjusts the text in the current paragraph so that each line has the maximum number of words between the left and right margins. The left margin is determined by looking at the number of spaces preceding the second line of the para- graph. The right margin is set with one of the above commands. Word Wrap Turns the word wrap feature ON or OFF. F10 Quit ~~~~~~~~ This command is used to exit Ued. If any of the workspaces have been modified in any way, you are prompted to verify that you really want to quit. Configuring Ued ~~~~~~~~~~~~~~~ A separate program (uedcfg.exe) is provided to modify Ued with some of your own preferences. When you run this Ued Configuration, you must ensure that Ued.exe is in the current directory. Follow the prompts for the configuration program, and when you have answered the last question Ued.exe will be updated with your selections. The following user preferences can be configured within Ued: - video display mode - initial text entry mode - initial Cut style - color of normal text - color of inverse text - distance between tab stops - initial right margin column Licensing ~~~~~~~~~ The programs and documentation in this archive are Copyright (c) 1989 by Useful Software Ued is a shareware editor. This means that you only pay for it if you decide to continue using it. If you don't think that it is worth the asking price, delete the program, or better yet give it to someone who might find it useful. However if you do decide to keep Ued after a 2 week trial period, please send $20 to: Useful Software 340 Dale Crescent Waterloo, Ontario Canada, N2J 3Y3 The shareware fee pays for unlimited use of Ued by a single person. You are allowed (and encouraged) to give away copies of Ued with the understanding that each person receiving a copy is under the same obligation as you are to send in the shareware fee if they decide to keep it. You can upload Ued to other computer systems, either free or commercial, as long as this archive remains intact, with the copyright and shareware notices unchanged. No guarantee is made as to the functionality of this software; however it has been tested quite thoroughly by a large number of people. If it doesn't do what you want, don't keep it and send no money. Please support the shareware concept. Shareware means useful programs at a fraction of the cost you might pay for them commercially. You can try-before-you-buy, and you are not subjected to copy protection or other atrocities that many software vendors inflict on their customers. Software updates can also be distributed much faster than is possible through normal channels. Any questions, suggestions, or bug reports, can be mailed to the above address. Enjoy. Useful Software